Home       Trees       Index       Help   

"Lemon"

Package lemon :: Package session :: Package drivers :: Module base :: Class Base
[show private | hide private]
[frames | no frames]

Class Base

Known Subclasses:
DB
This is the base class to derive session storage driver from. This class defines the interface
of the storage drivers. eg. SessionDB is the database session handler derived from this class.

If a sessionID is not specified and the sessionID cannot be read from a cookie, a new session is created
and the cookie is set.
Method Summary
  __init__(self, name, expires, sessionID, cookie, seed, cleanup)
Initialise the class with the parameters as specified in the lemon.session.start() function.
  __delitem__(self, key)
Allows the use of a dictionary-style interface to the session class.
  __getitem__(self, key)
Allows the use of a dictionary-style interface to the session class.
  __setitem__(self, key, value)
Allows the use of a dictionary-style interface to the session class.
  begin(self)
  blockVariable(self, key)
Deprecated.
  created(self)
Find out if a session was automatically created and hence whether this was the first visit.
  delete(self, key)
Public method to remove a session variable.
  destroy(self)
End a session and remove the session cookie.
  get(self, key)
Public method to retrieve a session variable.
  getParam(self, param)
Get the value of one of the params specified in lemon.session.start()...
  release(self, key)
Allow a user to use the previously reserved variable name 'key'.
  reserve(self, key)
Prevent a user using the variable name 'key'.
  set(self, key, value)
Public method to set a session variable.
  unblockVariable(self, key)
Deprecated.
  _addSession(sessionID)
Private method overridden in derived classes.
  _cleanupSessions(self)
Private method to remove all expired sessions.
  _createSession(self, length)
Private method to start a new session.
  _delete(self, key)
Private method overridden in derived classes.
  _genSessionID(self, st)
Private method to generate a new sessionID.
  _get(self, key)
Private method overridden in derived classes.
  _readCookie(self)
Private method to read the sessionID from the session cookie.
  _removeCookie(self)
Private method to remove session cookie.
  _removeSession(sessionID)
Private method overridden in derived classes.
  _sessionExists(self, sessionID)
Private method overridden in derived classes.
  _set(self, key, value)
Private method overridden in derived classes.
  _setCookie(self, length)
Private method to set the session cookie with the options specified by the cookie param in ...

Method Details

__init__(self, name, expires, sessionID, cookie, seed, cleanup)
(Constructor) 

Initialise the class with the parameters as specified in the lemon.session.start() function.

__delitem__(self, key)
(Index deletion operator) 

Allows the use of a dictionary-style interface to the session class.

__getitem__(self, key)
(Indexing operator) 

Allows the use of a dictionary-style interface to the session class.

__setitem__(self, key, value)
(Index assignment operator) 

Allows the use of a dictionary-style interface to the session class.

blockVariable(self, key) 

Deprecated. See reserve().

created(self) 

Find out if a session was automatically created and hence whether this was the first visit.

delete(self, key) 

Public method to remove a session variable.

destroy(self) 

End a session and remove the session cookie.

get(self, key) 

Public method to retrieve a session variable.

getParam(self, param) 

Get the value of one of the params specified in lemon.session.start()

release(self, key) 

Allow a user to use the previously reserved variable name 'key'.

reserve(self, key) 

Prevent a user using the variable name 'key'.

set(self, key, value) 

Public method to set a session variable. 'value' can be anything that can be pickled.

unblockVariable(self, key) 

Deprecated. See release().

_addSession(sessionID) 

Private method overridden in derived classes. Creates a new session setting the 'Created' and 'Accessed' variables.

_cleanupSessions(self) 

Private method to remove all expired sessions.

_createSession(self, length) 

Private method to start a new session.

_delete(self, key) 

Private method overridden in derived classes. Removes the variable 'key' from the session store.

_genSessionID(self, st) 

Private method to generate a new sessionID. Uses the entropySeed specified in Lemon.ini.

_get(self, key) 

Private method overridden in derived classes. Gets the variable 'key' from the session store.

_readCookie(self) 

Private method to read the sessionID from the session cookie.

_removeCookie(self) 

Private method to remove session cookie.

_removeSession(sessionID) 

Private method overridden in derived classes. Removes session information from the session store.

_sessionExists(self, sessionID) 

Private method overridden in derived classes. Returns True if the session already exists, False otherwise.

_set(self, key, value) 

Private method overridden in derived classes. Sets the variable 'key' to the value 'value'.

_setCookie(self, length) 

Private method to set the session cookie with the options specified by the cookie param in 
lemon.session.start()

   Home       Trees       Index       Help   

"Lemon"

Generated by Epydoc 2.0 on Mon Nov 10 15:08:18 2003 http://epydoc.sf.net